XaitCPQ API

GET data/{name}/{recordId}

Gets a record using the default section layout.

Request Information

URI

https://ofd-api.blueprintcpq.net/data/{name}/{recordId}?fields[0]={fields[0]}&fields[1]={fields[1]}&share={share}

URI Parameters

NameDescriptionTypeAdditional information
name

Page name.

 string

Required
recordId

Record Identifier.

 string

Required
fields

Fields to include

 Collection of string

Required
share

Optional share parameter

 globally unique identifier

None.

Body Parameters

None.

Response Information

Resource Description

Section Data.

SectionData
NameDescriptionTypeAdditional information
Section

string

None.
Locked

boolean

None.
Data

Collection of DataValue

None.

Response Formats

application/json, text/json

Sample: 
{
  "Section": "sample string 1",
  "Locked": true,
  "Data": [
    {
      "Field": "04d32753-2ccd-4f2e-bbe3-3de275ff7b9e",
      "FieldName": "sample string 2",
      "Locked": true,
      "Component": "sample string 4",
      "Value": {},
      "HumanReadableValue": {}
    },
    {
      "Field": "04d32753-2ccd-4f2e-bbe3-3de275ff7b9e",
      "FieldName": "sample string 2",
      "Locked": true,
      "Component": "sample string 4",
      "Value": {},
      "HumanReadableValue": {}
    }
  ]
}

text/html

Sample: 
{"Section":"sample string 1","Locked":true,"Data":[{"Field":"04d32753-2ccd-4f2e-bbe3-3de275ff7b9e","FieldName":"sample string 2","Locked":true,"Component":"sample string 4","Value":{},"HumanReadableValue":{}},{"Field":"04d32753-2ccd-4f2e-bbe3-3de275ff7b9e","FieldName":"sample string 2","Locked":true,"Component":"sample string 4","Value":{},"HumanReadableValue":{}}]}

application/xml, text/xml

Sample: 
<SectionData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Shared.Models.DataModels">
  <Data>
    <DataValue>
      <Component>sample string 4</Component>
      <Field>04d32753-2ccd-4f2e-bbe3-3de275ff7b9e</Field>
      <FieldName>sample string 2</FieldName>
      <HumanReadableValue />
      <Locked>true</Locked>
      <Value />
    </DataValue>
    <DataValue>
      <Component>sample string 4</Component>
      <Field>04d32753-2ccd-4f2e-bbe3-3de275ff7b9e</Field>
      <FieldName>sample string 2</FieldName>
      <HumanReadableValue />
      <Locked>true</Locked>
      <Value />
    </DataValue>
  </Data>
  <Locked>true</Locked>
  <Section>sample string 1</Section>
</SectionData>